<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ipcpipelinesink: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-intervideosrc.html" title="intervideosrc">
<link rel="next" href="gst-plugins-bad-plugins-ipcpipelinesrc.html" title="ipcpipelinesrc">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-ipcpipelinesink.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-ipcpipelinesink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-ipcpipelinesink.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-ipcpipelinesink.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-plugins-intervideosrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-plugins-ipcpipelinesrc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-plugins-ipcpipelinesink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-ipcpipelinesink.top_of_page"></a>ipcpipelinesink</span></h2>
<p>ipcpipelinesink</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--ack-time" title="The “ack-time” property">ack-time</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--fdin" title="The “fdin” property">fdin</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--fdout" title="The “fdout” property">fdout</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink--read-chunk-size" title="The “read-chunk-size” property">read-chunk-size</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink-disconnect" title="The “disconnect” signal">disconnect</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
</tr></tbody>
</table></div>
</div>
<a name="GstIpcPipelineSink"></a><div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink-struct" title="struct GstIpcPipelineSink">GstIpcPipelineSink</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> GstIpcPipelineSink
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.description"></a><h2>Description</h2>
<p>Communicates with an ipcpipelinesrc element in another process via a socket.</p>
<p>This element, together with ipcpipelinesrc and ipcslavepipeline form a
mechanism that allows splitting a single pipeline in different processes.
The main use-case for it is a playback pipeline split in two parts, where the
first part contains the networking, parsing and demuxing and the second part
contains the decoding and display. The intention of this split is to improve
security of an application, by letting the networking, parsing and demuxing
parts run in a less privileged process than the process that accesses the
decoder and display.</p>
<p>Once the pipelines in those different processes have been created, the
playback can be controlled entirely from the first pipeline, which is the
one that contains ipcpipelinesink. We call this pipeline the “master”.
All relevant events and queries sent from the application are sent to
the master pipeline and messages to the application are sent from the master
pipeline. The second pipeline, in the other process, is transparently slaved.</p>
<p>ipcpipelinesink can work only in push mode and does not synchronize buffers
to the clock. Synchronization is meant to happen either at the real sink at
the end of the remote slave pipeline, or not to happen at all, if the
pipeline is live.</p>
<p>A master pipeline may contain more than one ipcpipelinesink elements, which
can be connected either to the same slave pipeline or to different ones.</p>
<p>Communication with ipcpipelinesrc on the slave happens via a socket, using a
custom protocol. Each buffer, event, query, message or state change is
serialized in a "packet" and sent over the socket. The sender then
performs a blocking wait for a reply, if a return code is needed.</p>
<p>All objects that contan a GstStructure (messages, queries, events) are
serialized by serializing the GstStructure to a string
(gst_structure_to_string). This implies some limitations, of course.
All fields of this structures that are not serializable to strings (ex.
object pointers) are ignored, except for some cases where custom
serialization may occur (ex error/warning/info messages that contain a
GError are serialized differently).</p>
<p>Buffers are transported by writing their content directly on the socket.
More efficient ways for memory sharing could be implemented in the future.</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.117.8.10.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-bad-plugins-plugin-ipcpipeline.html#plugin-ipcpipeline">ipcpipeline</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Vincent Penquerc'h &lt;vincent.penquerch@collabora.co.uk&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Sink</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.117.8.10.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstIpcPipelineSink-struct"></a><h3>struct GstIpcPipelineSink</h3>
<pre class="programlisting">struct GstIpcPipelineSink;</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstIpcPipelineSink--ack-time"></a><h3>The <code class="literal">“ack-time”</code> property</h3>
<pre class="programlisting">  “ack-time”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>Maximum time to wait for a response to a message.</p>
<p>Flags: Read / Write</p>
<p>Default value: 10000000</p>
</div>
<hr>
<div class="refsect2">
<a name="GstIpcPipelineSink--fdin"></a><h3>The <code class="literal">“fdin”</code> property</h3>
<pre class="programlisting">  “fdin”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>File descriptor to received data from.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [G_MAXULONG,65535]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="GstIpcPipelineSink--fdout"></a><h3>The <code class="literal">“fdout”</code> property</h3>
<pre class="programlisting">  “fdout”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>File descriptor to send data through.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [G_MAXULONG,65535]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="GstIpcPipelineSink--read-chunk-size"></a><h3>The <code class="literal">“read-chunk-size”</code> property</h3>
<pre class="programlisting">  “read-chunk-size”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Read chunk size.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [1,16777216]</p>
<p>Default value: 4096</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GstIpcPipelineSink-disconnect"></a><h3>The <code class="literal">“disconnect”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="gst-plugins-bad-plugins-ipcpipelinesink.html#GstIpcPipelineSink"><span class="type">GstIpcPipelineSink</span></a> *gstipcpipelinesink,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)</pre>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-ipcpipelinesink.see-also"></a><h2>See Also</h2>
<p><a class="link" href="gst-plugins-bad-plugins-ipcpipelinesrc.html#GstIpcPipelineSrc"><span class="type">GstIpcPipelineSrc</span></a>, <a class="link" href="gst-plugins-bad-plugins-ipcslavepipeline.html#GstIpcSlavePipeline"><span class="type">GstIpcSlavePipeline</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>